Search
K
Upload Assets

Finalise an uploaded file

The endpoints described in Step 4 are an Either/Or choice. You should use either the Finalise an uploaded file endpoint to finalize and process a standard upload, or the Finalize additional file endpoint to finalize and save an additional uploaded file as a new asset.

post

Path Parameters

uploadIdstringrequired

Example:T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM

Headers

Content-Typestringrequired

Body

application/x-www-form-urlencoded
chunksnumberrequired

Total number of chunks uploaded.

Example:5

original_filenamestring

Filename including special characters to be displayed in Bynder.

Example:Logo.png

s3_filenamestringrequired

Base location of the uploaded file.

Example:api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png

targetidstringrequired

Target id as returned by the initialise call.

Example:final/E3333526-7F87-49F9-B49C0054C0D31477/Logo.png

Response

application/json

Accepted

ApiV4UploadResponse1

batchIdstring

Example:00000000-0000-0000-0000000000000000

fileobject
Show Child Parameters
filenamestring

Example:final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG

importIdstring

Example:000000000-0000-0000-0000000000000000

locationTypestring

Example:s3

outputstring

Example:final/2ba07d00-586a-4a44-b13c-c58598cfe828/

successinteger

Example:1

post/api/v4/upload/{uploadId}/

Body

{ "chunks": 5, "s3_filename": "api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png", "targetid": "final/E3333526-7F87-49F9-B49C0054C0D31477/Logo.png" }
 
application/json

Step 4 OR Finalize and save an additional uploaded file as a new asset.

Finalize additional file

The endpoints described in Step 4 are an Either/Or choice. You should use either the Finalise an uploaded file endpoint to finalize and process a standard upload, or the Finalize additional file endpoint to finalize and save an additional uploaded file as a new asset.

post

Path Parameters

idstringrequired

Asset id to which to save the new additional.

Example:00000000-0000-0000-0000-000000000000

uploadIdstringrequired

The upload id of the file.

Example:T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM

Body

application/x-www-form-urlencoded
chunksnumber

Total number of chunks uploaded.

Example:5

s3_filenamestring

Base location of the uploaded file.

Example:api_uploads/00000000-0000-0000-0000-000000000000/00000000-0000-0000-000000000000/Logo.png

targetIdstring

Target id as returned by the initialise call.

Example:final/00000000-0000-0000-0000-000000000000/Logo.png

Response

201 application/json

Created

post/api/v4/media/{id}/save/additional/{uploadId}/

Body

{}
 
201 application/json

Step 5 Poll for processing status

This endpoint allows you to check the processing status of a finalized upload. It should be called repeatedly until the response indicates that the processing is complete or provides the item IDs of the processed files.

Retrieve poll state

This call needs to be executed in a loop until its response returns the item(s) id(s) passed in the items parameter.

get

Query Parameters

itemsstringrequired

Comma-separated import id’s of a finalised file, as returned by the finalise call.

Example:00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000

Response

200 application/json

Successful response

get/api/v4/upload/poll
 
200 application/json